Interface SingleKeySigner

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 {
    accountAddress: AccountAddress;
    publicKey: AccountPublicKey;
    signingScheme: SigningScheme;
    getAnyPublicKey(): AnyPublicKey;
    sign(message: HexInput): Signature;
    signTransaction(transaction: AnyRawTransaction): Signature;
    signTransactionWithAuthenticator(transaction: AnyRawTransaction): AccountAuthenticator;
    signWithAuthenticator(message: HexInput): AccountAuthenticator;
    verifySignature(args: VerifySignatureArgs): boolean;
}

Hierarchy (view full)

Account
- SingleKeySigner

Implemented by

Index

Implementation - Account (On-Chain Model)

accountAddress publicKey signingScheme sign signTransaction signTransactionWithAuthenticator signWithAuthenticator verifySignature

Methods

getAnyPublicKey

Implementation - Account (On-Chain Model)

`Abstract` `Readonly`accountAddress

accountAddress: AccountAddress

Account address associated with the account

`Abstract` `Readonly`publicKey

publicKey: AccountPublicKey

Public key associated with the account

`Abstract`signingScheme

signingScheme: SigningScheme

Signing scheme used to sign transactions

`Abstract`sign

sign(message): Signature
Sign the given message using the available signing capabilities.
Parameters
- message: HexInput
  in HexInput format
Returns Signature
Signature
Inherited from Account.sign
- Defined in src/account/Account.ts:309

`Abstract`signTransaction

signTransaction(transaction): Signature
Sign the given transaction using the available signing capabilities.
Parameters
- transaction: AnyRawTransaction
  the transaction to be signed
Returns Signature
Signature
Inherited from Account.signTransaction
- Defined in src/account/Account.ts:318

`Abstract`signTransactionWithAuthenticator

signTransactionWithAuthenticator(transaction): AccountAuthenticator
Sign a transaction using the available signing capabilities.
Parameters
- transaction: AnyRawTransaction
  the raw transaction
Returns AccountAuthenticator
the AccountAuthenticator containing the signature of the transaction, together with the account's public key
Inherited from Account.signTransactionWithAuthenticator
- Defined in src/account/Account.ts:300

`Abstract`signWithAuthenticator

signWithAuthenticator(message): AccountAuthenticator
Sign a message using the available signing capabilities.
Parameters
- message: HexInput
  the signing message, as binary input
Returns AccountAuthenticator
the AccountAuthenticator containing the signature, together with the account's public key
Inherited from Account.signWithAuthenticator
- Defined in src/account/Account.ts:291

verifySignature

verifySignature(args): boolean
Verify the given message and signature with the public key. This function helps ensure the integrity and authenticity of a message by validating its signature.
Parameters
- args: VerifySignatureArgs
  The arguments for verifying the signature.
Returns boolean
A boolean indicating whether the signature is valid.
Inherited from Account.verifySignature
- Defined in src/account/Account.ts:331

Methods

getAnyPublicKey

getAnyPublicKey(): AnyPublicKey
Returns AnyPublicKey
- Defined in src/account/SingleKeyAccount.ts:16