Class AccountAuthenticatorSingleKey

Represents an account authenticator that utilizes a single key for signing. This class is designed to handle authentication using a public key and its corresponding signature.

Param: public_key

The public key used for authentication.

Param: signature

The signature associated with the public key.

Hierarchy (view full)

AccountAuthenticator
- AccountAuthenticatorSingleKey

Index

Constructors

constructor

new AccountAuthenticatorSingleKey(public_key, signature): AccountAuthenticatorSingleKey
Parameters
- public_key: AnyPublicKey
- signature: AnySignature
Returns AccountAuthenticatorSingleKey
Overrides AccountAuthenticator.constructor
- Defined in src/transactions/authenticator/account.ts:173

Methods

bcsToBytes

bcsToBytes(): Uint8Array
Serializes a Serializable value to its BCS representation. This function is the TypeScript SDK equivalent of bcs::to_bytes in Move.

Returns Uint8Array
the BCS representation of the Serializable instance as a byte buffer.
Inherited from AccountAuthenticator.bcsToBytes
- Defined in src/bcs/serializer.ts:29

bcsToHex

bcsToHex(): Hex
Converts the BCS-serialized bytes of a value into a Hex instance. This function provides a Hex representation of the BCS-serialized data for easier handling and manipulation.

Returns Hex
A Hex instance with the BCS-serialized bytes loaded into its underlying Uint8Array.
Inherited from AccountAuthenticator.bcsToHex
- Defined in src/bcs/serializer.ts:40

isEd25519

isEd25519(): this is AccountAuthenticatorEd25519
Determines if the current instance is an Ed25519 account authenticator.

Returns this is AccountAuthenticatorEd25519
True if the instance is of type AccountAuthenticatorEd25519, otherwise false.
Inherited from AccountAuthenticator.isEd25519
- Defined in src/transactions/authenticator/account.ts:50

isMultiEd25519

isMultiEd25519(): this is AccountAuthenticatorMultiEd25519
Determines if the current instance is of type AccountAuthenticatorMultiEd25519.

Returns this is AccountAuthenticatorMultiEd25519
True if the instance is a multi-signature Ed25519 account authenticator, otherwise false.
Inherited from AccountAuthenticator.isMultiEd25519
- Defined in src/transactions/authenticator/account.ts:59

isMultiKey

isMultiKey(): this is AccountAuthenticatorMultiKey
Determine if the current instance is of type AccountAuthenticatorMultiKey.

Returns this is AccountAuthenticatorMultiKey
Returns true if the instance is an AccountAuthenticatorMultiKey, otherwise false.
Inherited from AccountAuthenticator.isMultiKey
- Defined in src/transactions/authenticator/account.ts:77

isSingleKey

isSingleKey(): this is AccountAuthenticatorSingleKey
Determines if the current instance is of the type AccountAuthenticatorSingleKey.

Returns this is AccountAuthenticatorSingleKey
True if the instance is an AccountAuthenticatorSingleKey, otherwise false.
Inherited from AccountAuthenticator.isSingleKey
- Defined in src/transactions/authenticator/account.ts:68

serialize

serialize(serializer): void
Parameters
- serializer: Serializer
Returns void
Overrides AccountAuthenticator.serialize
- Defined in src/transactions/authenticator/account.ts:179

toString

toString(): string
Returns the hex string representation of the Serializable value with the 0x prefix.

Returns string
the hex formatas a string prefixed by 0x.
Inherited from AccountAuthenticator.toString
- Defined in src/bcs/serializer.ts:57

toStringWithoutPrefix

toStringWithoutPrefix(): string
Returns the hex string representation of the Serializable value without the 0x prefix.

Returns string
the hex format as a string without 0x prefix.
Inherited from AccountAuthenticator.toStringWithoutPrefix
- Defined in src/bcs/serializer.ts:49

`Static`deserialize

deserialize(deserializer): AccountAuthenticator
Deserializes an AccountAuthenticator from the provided deserializer. This function helps in reconstructing the AccountAuthenticator object based on the variant index.
Parameters
- deserializer: Deserializer
  The deserializer instance used to read the serialized data.
Returns AccountAuthenticator
Inherited from AccountAuthenticator.deserialize
- Defined in src/transactions/authenticator/account.ts:29

`Static`load

load(deserializer): AccountAuthenticatorSingleKey
Parameters
- deserializer: Deserializer
Returns AccountAuthenticatorSingleKey
- Defined in src/transactions/authenticator/account.ts:185

Properties

`Readonly`public_key

public_key: AnyPublicKey

`Readonly`signature

signature: AnySignature

Class AccountAuthenticatorSingleKey

Param: public_key

Param: signature

Hierarchy (view full)

Index

Constructors

Methods

Properties

Constructors

constructor

Parameters

Returns AccountAuthenticatorSingleKey

Methods

bcsToBytes

Returns Uint8Array

bcsToHex

Returns Hex

isEd25519

Returns this is AccountAuthenticatorEd25519

isMultiEd25519

Returns this is AccountAuthenticatorMultiEd25519

isMultiKey

Returns this is AccountAuthenticatorMultiKey

isSingleKey

Returns this is AccountAuthenticatorSingleKey

serialize

Parameters

Returns void

toString

Returns string

toStringWithoutPrefix

Returns string

Staticdeserialize

Parameters

Returns AccountAuthenticator

Staticload

Parameters

Returns AccountAuthenticatorSingleKey

Properties

Readonlypublic_key

Readonlysignature

Settings

On This Page

`Static`deserialize

`Static`load

`Readonly`public_key

`Readonly`signature