Class AccountAuthenticator`Abstract`

Represents an account authenticator that can handle multiple authentication variants. This class serves as a base for different types of account authenticators, allowing for serialization and deserialization of various authenticator types.

Hierarchy (view full)

Serializable
- AccountAuthenticator

Index

Constructors

Methods

bcsToBytes bcsToHex isEd25519 isMultiEd25519 isMultiKey isSingleKey serialize toString toStringWithoutPrefix deserialize

Constructors

constructor

new AccountAuthenticator(): AccountAuthenticator
Returns AccountAuthenticator
Inherited from Serializable.constructor

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 Serializable.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 Serializable.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.
- 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.
- 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.
- 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.
- Defined in src/transactions/authenticator/account.ts:68

`Abstract`serialize

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

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 Serializable.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 Serializable.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
- Defined in src/transactions/authenticator/account.ts:29