@aptos-labs/ts-sdk 1.33.1 → 1.33.2

package/dist/esm/{Ed25519Account-B3xHXAQe.d.mts → Ed25519Account-D4j3_WIS.d.mts}

@@ -2,32 +2,47 @@ import { AccountAuthenticatorSingleKey, AccountAuthenticator, AccountAuthenticat
 import { SigningSchemeInput, HexInput, SigningScheme } from './types/types.mjs';
 import { AccountAddressInput, AccountAddress } from './core/accountAddress.mjs';
 import { Ed25519PrivateKey, Ed25519Signature, Ed25519PublicKey } from './core/crypto/ed25519.mjs';
-import { a as AccountPublicKey, A as AuthenticationKey, V as VerifySignatureArgs } from './publicKey-BVXX1nVl.mjs';
+import { a as AccountPublicKey, A as AuthenticationKey, V as VerifySignatureArgs } from './publicKey-BMtGNNLg.mjs';
 import { Signature } from './core/crypto/signature.mjs';
-import { PrivateKey } from './core/crypto/privateKey.mjs';
+import { AnyPublicKey, PrivateKeyInput, AnySignature } from './core/crypto/singleKey.mjs';
 import { AnyRawTransaction } from './transactions/types.mjs';
-import { AnySignature, AnyPublicKey } from './core/crypto/singleKey.mjs';
 
+/**
+ * An interface which defines if an Account utilizes SingleKey signing.
+ *
+ * Such an account will use the AnyPublicKey enum to represent its public key when deriving the auth key.
+ */
+interface SingleKeySigner extends Account {
+    getAnyPublicKey(): AnyPublicKey;
+}
+declare function isSingleKeySigner(obj: unknown): obj is SingleKeySigner;
+type SingleKeySignerOrLegacyEd25519Account = SingleKeySigner | Ed25519Account;
 /**
  * Arguments required to create a single key signer.
  *
  * @param privateKey - The private key used for signing.
  * @param address - Optional account address associated with the signer.
+ * @group Implementation
+ * @category Account (On-Chain Model)
  */
 interface SingleKeySignerConstructorArgs {
-    privateKey: PrivateKey;
+    privateKey: PrivateKeyInput;
     address?: AccountAddressInput;
 }
 /**
  * Arguments for generating a single key signer.
  *
  * @param scheme - The signing scheme to be used.
+ * @group Implementation
+ * @category Account (On-Chain Model)
  */
 interface SingleKeySignerGenerateArgs {
     scheme?: SigningSchemeInput;
 }
 /**
  * The arguments for generating a single key signer from a specified derivation path.
+ * @group Implementation
+ * @category Account (On-Chain Model)
  */
 type SingleKeySignerFromDerivationPathArgs = SingleKeySignerGenerateArgs & {
     path: string;
@@ -38,6 +53,8 @@ type SingleKeySignerFromDerivationPathArgs = SingleKeySignerGenerateArgs & {
  *
  * @param message - The message to be verified, represented in hexadecimal format.
  * @param signature - The signature that corresponds to the message.
+ * @group Implementation
+ * @category Account (On-Chain Model)
  */
 interface VerifySingleKeySignatureArgs {
     message: HexInput;
@@ -49,12 +66,16 @@ interface VerifySingleKeySignatureArgs {
  * Currently, the only supported signature schemes are Ed25519 and Secp256k1.
  *
  * Note: Generating a signer instance does not create the account on-chain.
+ * @group Implementation
+ * @category Account (On-Chain Model)
  */
-declare class SingleKeyAccount implements Account {
+declare class SingleKeyAccount implements Account, SingleKeySigner {
     /**
      * Private key associated with the account
+     * @group Implementation
+     * @category Account (On-Chain Model)
      */
-    readonly privateKey: PrivateKey;
+    readonly privateKey: PrivateKeyInput;
     readonly publicKey: AnyPublicKey;
     readonly accountAddress: AccountAddress;
     readonly signingScheme = SigningScheme.SingleKey;
@@ -65,8 +86,11 @@ declare class SingleKeyAccount implements Account {
      * @param args - The constructor arguments for initializing the SingleKeySigner.
      * @param args.privateKey - The private key used for signing.
      * @param args.address - The optional account address; if not provided, it will derive the address from the public key.
+     * @group Implementation
+     * @category Account (On-Chain Model)
      */
     constructor(args: SingleKeySignerConstructorArgs);
+    getAnyPublicKey(): AnyPublicKey;
     /**
      * Derives an account from a randomly generated private key based on the specified signing scheme.
      * The default generation scheme is Ed25519, but it can also support Secp256k1Ecdsa.
@@ -75,6 +99,8 @@ declare class SingleKeyAccount implements Account {
      * @param args.scheme - The signing scheme to use for generating the private key. Defaults to SigningSchemeInput.Ed25519.
      * @returns An account with the generated private key based on the specified signing scheme.
      * @throws Error if an unsupported signature scheme is provided.
+     * @group Implementation
+     * @category Account (On-Chain Model)
      */
     static generate(args?: SingleKeySignerGenerateArgs): SingleKeyAccount;
     /**
@@ -87,6 +113,8 @@ declare class SingleKeyAccount implements Account {
      * (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.
+     * @group Implementation
+     * @category Account (On-Chain Model)
      */
     static fromDerivationPath(args: SingleKeySignerFromDerivationPathArgs): SingleKeyAccount;
     /**
@@ -96,6 +124,8 @@ declare class SingleKeyAccount implements Account {
      * @param args.message - The raw message data in HexInput format.
      * @param args.signature - The signed message signature.
      * @returns A boolean indicating whether the signature is valid.
+     * @group Implementation
+     * @category Account (On-Chain Model)
      */
     verifySignature(args: VerifySingleKeySignatureArgs): boolean;
     /**
@@ -103,6 +133,8 @@ declare class SingleKeyAccount implements Account {
      * account's public key.
      * @param message - The signing message, represented as binary input in hexadecimal format.
      * @returns An instance of AccountAuthenticatorSingleKey containing the signature and the public key.
+     * @group Implementation
+     * @category Account (On-Chain Model)
      */
     signWithAuthenticator(message: HexInput): AccountAuthenticatorSingleKey;
     /**
@@ -110,12 +142,16 @@ declare class SingleKeyAccount implements Account {
      * This function returns an AccountAuthenticator that contains the signature of the transaction along with the account's public key.
      * @param transaction - The raw transaction to be signed.
      * @returns An AccountAuthenticatorSingleKey containing the signature of the transaction and the account's public key.
+     * @group Implementation
+     * @category Account (On-Chain Model)
      */
     signTransactionWithAuthenticator(transaction: AnyRawTransaction): AccountAuthenticatorSingleKey;
     /**
      * Sign the given message using the account's private key.
      * @param message - The message to be signed in HexInput format.
      * @returns A new AnySignature containing the signature of the message.
+     * @group Implementation
+     * @category Account (On-Chain Model)
      */
     sign(message: HexInput): AnySignature;
     /**
@@ -124,8 +160,11 @@ declare class SingleKeyAccount implements Account {
      *
      * @param transaction - The transaction to be signed.
      * @returns Signature - The resulting signature for the signed transaction.
+     * @group Implementation
+     * @category Account (On-Chain Model)
      */
     signTransaction(transaction: AnyRawTransaction): AnySignature;
+    static fromEd25519Account(account: Ed25519Account): SingleKeyAccount;
 }
 
 /**
@@ -135,6 +174,8 @@ declare class SingleKeyAccount implements Account {
  * @param privateKey - The private key used to create the account.
  * @param address - Optional address for the account.
  * @param legacy - Indicates whether to use legacy authentication (default is true).
+ * @group Implementation
+ * @category Account (On-Chain Model)
  */
 interface CreateEd25519AccountFromPrivateKeyArgs {
     privateKey: Ed25519PrivateKey;
@@ -148,6 +189,8 @@ interface CreateEd25519AccountFromPrivateKeyArgs {
  * @param privateKey - The Ed25519 private key used for account creation.
  * @param address - Optional account address input.
  * @param legacy - Must be false to enable the `SingleKey` authentication scheme.
+ * @group Implementation
+ * @category Account (On-Chain Model)
  */
 interface CreateEd25519SingleKeyAccountFromPrivateKeyArgs {
     privateKey: Ed25519PrivateKey;
@@ -161,9 +204,11 @@ interface CreateEd25519SingleKeyAccountFromPrivateKeyArgs {
  * @param privateKey - The private key used to create the account.
  * @param address - Optional address input for the account.
  * @param legacy - Always false; cannot be explicitly set to true.
+ * @group Implementation
+ * @category Account (On-Chain Model)
  */
 interface CreateSingleKeyAccountFromPrivateKeyArgs {
-    privateKey: Exclude<PrivateKey, Ed25519PrivateKey>;
+    privateKey: PrivateKeyInput;
     address?: AccountAddressInput;
     legacy?: false;
 }
@@ -173,9 +218,11 @@ interface CreateSingleKeyAccountFromPrivateKeyArgs {
  * @param privateKey - The private key used to create the account.
  * @param address - Optional address for the account.
  * @param legacy - Optional flag indicating if the account is a legacy account.
+ * @group Implementation
+ * @category Account (On-Chain Model)
  */
 interface CreateAccountFromPrivateKeyArgs {
-    privateKey: PrivateKey;
+    privateKey: PrivateKeyInput;
     address?: AccountAddressInput;
     legacy?: boolean;
 }
@@ -184,6 +231,8 @@ interface CreateAccountFromPrivateKeyArgs {
  *
  * @param scheme - The signing scheme to use for the account.
  * @param legacy - Indicates if the account should be created in legacy mode.
+ * @group Implementation
+ * @category Account (On-Chain Model)
  */
 interface GenerateEd25519AccountArgs {
     scheme?: SigningSchemeInput.Ed25519;
@@ -195,6 +244,8 @@ interface GenerateEd25519AccountArgs {
  *
  * @param scheme - Optional signing scheme input for the account.
  * @param legacy - Indicates whether to use legacy account generation.
+ * @group Implementation
+ * @category Account (On-Chain Model)
  */
 interface GenerateEd25519SingleKeyAccountArgs {
     scheme?: SigningSchemeInput.Ed25519;
@@ -206,6 +257,8 @@ interface GenerateEd25519SingleKeyAccountArgs {
  *
  * @param scheme - The signing scheme to use for the account.
  * @param legacy - Indicates whether to use legacy account generation (defaults to false).
+ * @group Implementation
+ * @category Account (On-Chain Model)
  */
 interface GenerateSingleKeyAccountArgs {
     scheme: Exclude<SigningSchemeInput, SigningSchemeInput.Ed25519>;
@@ -216,6 +269,8 @@ interface GenerateSingleKeyAccountArgs {
  *
  * @param scheme - The signing scheme to use for account generation.
  * @param legacy - Indicates whether to use legacy account generation methods.
+ * @group Implementation
+ * @category Account (On-Chain Model)
  */
 interface GenerateAccountArgs {
     scheme?: SigningSchemeInput;
@@ -226,6 +281,8 @@ interface GenerateAccountArgs {
  *
  * @param path - The BIP44 derivation path for the key.
  * @param mnemonic - The mnemonic phrase used for key generation.
+ * @group Implementation
+ * @category Account (On-Chain Model)
  */
 interface PrivateKeyFromDerivationPathArgs {
     path: string;
@@ -239,18 +296,26 @@ interface PrivateKeyFromDerivationPathArgs {
  * 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.
+ * @group Implementation
+ * @category Account (On-Chain Model)
  */
 declare abstract class Account {
     /**
      * Public key associated with the account
+     * @group Implementation
+     * @category Account (On-Chain Model)
      */
     abstract readonly publicKey: AccountPublicKey;
     /**
      * Account address associated with the account
+     * @group Implementation
+     * @category Account (On-Chain Model)
      */
     abstract readonly accountAddress: AccountAddress;
     /**
      * Signing scheme used to sign transactions
+     * @group Implementation
+     * @category Account (On-Chain Model)
      */
     abstract signingScheme: SigningScheme;
     /**
@@ -260,6 +325,8 @@ declare abstract class Account {
      * @param args - The arguments for generating the account.
      * @param args.scheme - The signing scheme to use for account generation. Defaults to Ed25519.
      * @param args.legacy - Indicates whether to use the legacy account generation method. Defaults to true.
+     * @group Implementation
+     * @category Account (On-Chain Model)
      */
     static generate(args?: GenerateEd25519AccountArgs): Ed25519Account;
     static generate(args: GenerateEd25519SingleKeyAccountArgs): SingleKeyAccount;
@@ -275,11 +342,12 @@ declare abstract class Account {
      * @param args.address - The address associated with the account.
      * @param args.legacy - A boolean indicating whether to create a legacy account (default is true).
      * @returns An instance of either Ed25519Account or SingleKeyAccount based on the provided private key.
+     * @group Implementation
+     * @category Account (On-Chain Model)
      */
     static fromPrivateKey(args: CreateEd25519AccountFromPrivateKeyArgs): Ed25519Account;
-    static fromPrivateKey(args: CreateEd25519SingleKeyAccountFromPrivateKeyArgs): SingleKeyAccount;
     static fromPrivateKey(args: CreateSingleKeyAccountFromPrivateKeyArgs): SingleKeyAccount;
-    static fromPrivateKey(args: CreateAccountFromPrivateKeyArgs): Account;
+    static fromPrivateKey(args: CreateAccountFromPrivateKeyArgs): SingleKeyAccount;
     /**
      * @deprecated use `fromPrivateKey` instead.
      * Instantiates an account using a private key and a specified account address. This is primarily used to instantiate an
@@ -292,8 +360,10 @@ declare abstract class Account {
      * Ed25519 keypair.
      *
      * @returns Account
+     * @group Implementation
+     * @category Account (On-Chain Model)
      */
-    static fromPrivateKeyAndAddress(args: CreateAccountFromPrivateKeyArgs): Account;
+    static fromPrivateKeyAndAddress(args: CreateAccountFromPrivateKeyArgs): SingleKeyAccount;
     /**
      * Generates an account from a specified derivation path and mnemonic.
      * This function allows you to create an account using different signing schemes based on the provided arguments.
@@ -303,6 +373,8 @@ declare abstract class Account {
      * @param args.mnemonic - The mnemonic phrase used to derive the account.
      * @param args.path - The derivation path used to generate the account.
      * @param args.legacy - A boolean indicating whether to use the legacy account generation method. Defaults to true.
+     * @group Implementation
+     * @category Account (On-Chain Model)
      */
     static fromDerivationPath(args: GenerateEd25519AccountArgs & PrivateKeyFromDerivationPathArgs): Ed25519Account;
     static fromDerivationPath(args: GenerateEd25519SingleKeyAccountArgs & PrivateKeyFromDerivationPathArgs): SingleKeyAccount;
@@ -317,6 +389,8 @@ declare abstract class Account {
      * @param args - The arguments for retrieving the authentication key.
      * @param args.publicKey - The public key of the account.
      * @returns The authentication key for the associated account.
+     * @group Implementation
+     * @category Account (On-Chain Model)
      */
     static authKey(args: {
         publicKey: AccountPublicKey;
@@ -325,24 +399,32 @@ declare abstract class Account {
      * 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
+     * @group Implementation
+     * @category Account (On-Chain Model)
      */
     abstract signWithAuthenticator(message: HexInput): AccountAuthenticator;
     /**
      * Sign a transaction using the available signing capabilities.
      * @param transaction the raw transaction
      * @return the AccountAuthenticator containing the signature of the transaction, together with the account's public key
+     * @group Implementation
+     * @category Account (On-Chain Model)
      */
     abstract signTransactionWithAuthenticator(transaction: AnyRawTransaction): AccountAuthenticator;
     /**
      * Sign the given message using the available signing capabilities.
      * @param message in HexInput format
      * @returns Signature
+     * @group Implementation
+     * @category Account (On-Chain Model)
      */
     abstract sign(message: HexInput): Signature;
     /**
      * Sign the given transaction using the available signing capabilities.
      * @param transaction the transaction to be signed
      * @returns Signature
+     * @group Implementation
+     * @category Account (On-Chain Model)
      */
     abstract signTransaction(transaction: AnyRawTransaction): Signature;
     /**
@@ -353,6 +435,8 @@ declare abstract class Account {
      * @param args.message - The raw message data in HexInput format.
      * @param args.signature - The signed message signature.
      * @returns A boolean indicating whether the signature is valid.
+     * @group Implementation
+     * @category Account (On-Chain Model)
      */
     verifySignature(args: VerifySignatureArgs): boolean;
 }
@@ -362,6 +446,8 @@ declare abstract class Account {
  *
  * @param privateKey - The private key used for signing.
  * @param address - Optional account address associated with the signer.
+ * @group Implementation
+ * @category Account (On-Chain Model)
  */
 interface Ed25519SignerConstructorArgs {
     privateKey: Ed25519PrivateKey;
@@ -372,6 +458,8 @@ interface Ed25519SignerConstructorArgs {
  *
  * @param path - The derivation path for the Ed25519 key.
  * @param mnemonic - The mnemonic phrase used to generate the key.
+ * @group Implementation
+ * @category Account (On-Chain Model)
  */
 interface Ed25519SignerFromDerivationPathArgs {
     path: string;
@@ -382,6 +470,8 @@ interface Ed25519SignerFromDerivationPathArgs {
  *
  * @param message - The message to be verified, represented in hexadecimal format.
  * @param signature - The Ed25519 signature to validate.
+ * @group Implementation
+ * @category Account (On-Chain Model)
  */
 interface VerifyEd25519SignatureArgs {
     message: HexInput;
@@ -392,10 +482,14 @@ interface VerifyEd25519SignatureArgs {
  * This class allows for the creation of accounts, signing messages and transactions, and verifying signatures.
  *
  * Note: Generating an instance of this class does not create the account on-chain.
+ * @group Implementation
+ * @category Account (On-Chain Model)
  */
 declare class Ed25519Account implements Account {
     /**
      * Private key associated with the account
+     * @group Implementation
+     * @category Account (On-Chain Model)
      */
     readonly privateKey: Ed25519PrivateKey;
     readonly publicKey: Ed25519PublicKey;
@@ -408,6 +502,8 @@ declare class Ed25519Account implements Account {
      * @param args - The constructor arguments for the Ed25519Signer.
      * @param args.privateKey - The private key used for signing.
      * @param args.address - The optional account address; if not provided, it will derive the address from the public key.
+     * @group Implementation
+     * @category Account (On-Chain Model)
      */
     constructor(args: Ed25519SignerConstructorArgs);
     /**
@@ -415,6 +511,8 @@ declare class Ed25519Account implements Account {
      * This function is useful for creating a signer that can be used for cryptographic operations.
      *
      * @returns {Ed25519Account} The newly generated Ed25519 account.
+     * @group Implementation
+     * @category Account (On-Chain Model)
      */
     static generate(): Ed25519Account;
     /**
@@ -424,6 +522,8 @@ declare class Ed25519Account implements Account {
      * @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.
+     * @group Implementation
+     * @category Account (On-Chain Model)
      */
     static fromDerivationPath(args: Ed25519SignerFromDerivationPathArgs): Ed25519Account;
     /**
@@ -433,6 +533,8 @@ declare class Ed25519Account implements Account {
      * @param args.message - Raw message data in HexInput format.
      * @param args.signature - Signed message signature.
      * @returns A boolean indicating whether the signature is valid.
+     * @group Implementation
+     * @category Account (On-Chain Model)
      */
     verifySignature(args: VerifyEd25519SignatureArgs): boolean;
     /**
@@ -441,6 +543,8 @@ declare class Ed25519Account implements Account {
      *
      * @param message - The signing message, represented as hexadecimal input.
      * @returns An AccountAuthenticator containing the signature and the account's public key.
+     * @group Implementation
+     * @category Account (On-Chain Model)
      */
     signWithAuthenticator(message: HexInput): AccountAuthenticatorEd25519;
     /**
@@ -449,12 +553,16 @@ declare class Ed25519Account implements Account {
      *
      * @param transaction - The raw transaction to be signed.
      * @returns An AccountAuthenticator containing the signature and the public key.
+     * @group Implementation
+     * @category Account (On-Chain Model)
      */
     signTransactionWithAuthenticator(transaction: AnyRawTransaction): AccountAuthenticatorEd25519;
     /**
      * Sign the given message using the account's Ed25519 private key.
      * @param message - The message to be signed in HexInput format.
      * @returns Signature - The resulting signature of the signed message.
+     * @group Implementation
+     * @category Account (On-Chain Model)
      */
     sign(message: HexInput): Ed25519Signature;
     /**
@@ -463,8 +571,10 @@ declare class Ed25519Account implements Account {
      *
      * @param transaction - The transaction to be signed.
      * @returns Signature - The resulting signature for the transaction.
+     * @group Implementation
+     * @category Account (On-Chain Model)
      */
     signTransaction(transaction: AnyRawTransaction): Ed25519Signature;
 }
 
-export { Account as A, type CreateEd25519AccountFromPrivateKeyArgs as C, type Ed25519SignerConstructorArgs as E, type GenerateEd25519AccountArgs as G, type PrivateKeyFromDerivationPathArgs as P, type SingleKeySignerConstructorArgs as S, type VerifyEd25519SignatureArgs as V, type Ed25519SignerFromDerivationPathArgs as a, Ed25519Account as b, type CreateEd25519SingleKeyAccountFromPrivateKeyArgs as c, type CreateSingleKeyAccountFromPrivateKeyArgs as d, type CreateAccountFromPrivateKeyArgs as e, type GenerateEd25519SingleKeyAccountArgs as f, type GenerateSingleKeyAccountArgs as g, type GenerateAccountArgs as h, type SingleKeySignerGenerateArgs as i, type SingleKeySignerFromDerivationPathArgs as j, type VerifySingleKeySignatureArgs as k, SingleKeyAccount as l };
+export { Account as A, type CreateEd25519AccountFromPrivateKeyArgs as C, type Ed25519SignerConstructorArgs as E, type GenerateEd25519AccountArgs as G, type PrivateKeyFromDerivationPathArgs as P, type SingleKeySigner as S, type VerifyEd25519SignatureArgs as V, type Ed25519SignerFromDerivationPathArgs as a, Ed25519Account as b, type CreateEd25519SingleKeyAccountFromPrivateKeyArgs as c, type CreateSingleKeyAccountFromPrivateKeyArgs as d, type CreateAccountFromPrivateKeyArgs as e, type GenerateEd25519SingleKeyAccountArgs as f, type GenerateSingleKeyAccountArgs as g, type GenerateAccountArgs as h, isSingleKeySigner as i, type SingleKeySignerOrLegacyEd25519Account as j, type SingleKeySignerConstructorArgs as k, type SingleKeySignerGenerateArgs as l, type SingleKeySignerFromDerivationPathArgs as m, type VerifySingleKeySignatureArgs as n, SingleKeyAccount as o };