Abstract Class: PublicKey

A public key

Extended by

• Ed25519PublicKey
• Secp256k1PublicKey
• Secp256r1PublicKey
• MultiSigPublicKey

Constructors

Constructor

new PublicKey(): PublicKey;

Returns

PublicKey

Methods

equals()

equals(publicKey): boolean;

Checks if two public keys are equal

Parameters

Parameter	Type
publicKey	PublicKey

Returns

boolean

---

toBase64()

toBase64(): string;

Return the base-64 representation of the public key

Returns

string

---

toString()

toString(): never;

Returns

never

---

toIotaPublicKey()

toIotaPublicKey(): string;

Return the IOTA representation of the public key encoded in base-64. An IOTA public key is formed by the concatenation of the scheme flag with the raw bytes of the public key

Returns

string

---

verifyWithIntent()

verifyWithIntent(
   bytes, 
   signature, 
intent): Promise<boolean>;

Parameters

Parameter	Type
bytes	Uint8Array
signature	string | Uint8Array
intent	IntentScope

Returns

Promise<boolean>

---

verifyPersonalMessage()

verifyPersonalMessage(message, signature): Promise<boolean>;

Verifies that the signature is valid for the provided PersonalMessage

Parameters

Parameter	Type
message	Uint8Array
signature	string | Uint8Array

Returns

Promise<boolean>

---

verifyTransaction()

verifyTransaction(transaction, signature): Promise<boolean>;

Verifies that the signature is valid for the provided Transaction

Parameters

Parameter	Type
transaction	Uint8Array
signature	string | Uint8Array

Returns

Promise<boolean>

---

verifyAddress()

verifyAddress(address): boolean;

Verifies that the public key is associated with the provided address

Parameters

Parameter	Type
address	string

Returns

boolean

---

toIotaBytes()

toIotaBytes(): Uint8Array;

Returns the bytes representation of the public key prefixed with the signature scheme flag

Returns

Uint8Array

---

toIotaBytesForAddress()

toIotaBytesForAddress(): Uint8Array;

Returns the bytes representation of the public key prefixed with the signature scheme flag. If the signature scheme is ED25519, no prefix is set.

Returns

Uint8Array

---

toIotaAddress()

toIotaAddress(): string;

Return the IOTA address associated with this Ed25519 public key

Returns

string

---

toRawBytes()

abstract toRawBytes(): Uint8Array;

Return the byte array representation of the public key

Returns

Uint8Array

---

flag()

abstract flag(): number;

Return signature scheme flag of the public key

Returns

number

---

verify()

abstract verify(data, signature): Promise<boolean>;

Verifies that the signature is valid for the provided message

Parameters

Parameter	Type
data	Uint8Array
signature	string | Uint8Array

Returns

Promise<boolean>